Skip to main content
POST
Export general ledger

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
ledger_id
string
required

Ledger identifier.

period_from
string<date>
required

First inclusive reporting date.

period_to
string<date>
required

Last inclusive reporting date.

invoicing_entity_id
string

Optional invoicing entity identifier.

status
enum<string>

Journal-entry status scope; defaults to posted.

Available options:
posted,
all
include_reversed
boolean

Whether reversed entries are included.

account_ids
string[]

Optional ledger-account identifiers.

account_types
enum<string>[]

Optional ledger-account types.

Available options:
asset,
contra_asset,
liability,
contra_liability,
equity,
revenue,
contra_revenue,
expense

Response

200 - application/json
id
string
required

Unique export identifier.

name
enum<string>
required

Accounting export template.

Available options:
revenue_recognition_waterfall,
revenue_recognition_summary,
income_statement,
general_ledger
status
enum<string>
required

Current export processing status.

Available options:
pending,
processing,
done,
error
file_type
enum<string>
required

Generated file type.

Available options:
csv,
xlsx,
json,
zip,
pdf,
doc,
docx,
xls,
txt,
jpeg,
jpg,
png
created_at
string<date> | null
required

Time at which the export was requested.

updated_at
string<date> | null
required

Time at which the export was last updated.